home *** CD-ROM | disk | FTP | other *** search
/ Aminet 49 / Aminet 49 (2002)(GTI - Schatztruhe)[!][Jun 2002].iso / Aminet / comm / news / slrn-BIN.lha / slrn-BIN-0.9.7.4 / contrib / cleanscore next >
Text File  |  2001-11-03  |  10KB  |  371 lines
  1. #!/usr/bin/perl -w
  2. # cleanscore - Remove expired entrys from slrn's Scorefile.
  3.  
  4. # Copyright (c) 1999 - 2001 Felix Schueller <fschueller@netcologne.de>
  5. # 
  6. # This program is free software; you can redistribute it and/or modify it
  7. # under the terms of the GNU General Public License as published by the Free
  8. # Software Foundation; either version 2 of the License, or (at your option)
  9. # any later version.
  10. #     
  11. # This program is distributed in the hope that it will be useful, but WITHOUT
  12. # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13. # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  14. # more details.
  15. #
  16. # You should have received a copy of the GNU General Public License along
  17. # with this program; if not, write to the Free Software Foundation, Inc.,
  18. # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.   
  19.  
  20. use Fcntl qw(:DEFAULT :flock);
  21.  
  22. sub help();
  23. sub reset_vars();
  24. sub insert_comment();
  25. sub end_of_score();
  26. sub clean_file($);
  27.  
  28. $version="0.9.8.0";
  29. $DEBUG = 0;
  30. $remove_comments = 0;
  31. $max_empty_lines = -1;
  32. $VERBOSE = 0;
  33. $keep = 0;
  34. $test_only = 0;
  35. $save_file = "";
  36. $bak_ext = ".bak";
  37. $ign_pat = "";
  38.  
  39. require "getopts.pl"; &Getopts('b:de:f:hi:k:hrs:tVv');
  40. if (defined($opt_b)) {$bak_ext = $opt_b;}
  41. if (defined($opt_d)) {$DEBUG = $opt_d;}
  42. if (defined($opt_e)) {$max_empty_lines = $opt_e;}
  43. if (defined($opt_h)) {help(); exit(0);}
  44. if (defined($opt_i)) {$ign_pat = $opt_i;}
  45. if (defined($opt_r)) {$remove_comments = $opt_r;}
  46. if (defined($opt_s)) {$save_file = $opt_s;}
  47. if (defined($opt_t)) {$test_only = $opt_t;}
  48. if (defined($opt_k)) {$keep = $opt_k * 86400;}
  49. if (defined($opt_v)) {$VERBOSE = $opt_v;}
  50. if (defined($opt_V)) {print ("cleanscore - Version: $version (bugreports to: fschueller\@netcologne.de)\n"); exit(0);}
  51. $opt_h = $opt_V; # suppress 'perl -w' warnings.
  52.  
  53. if (defined($opt_f))
  54.   {
  55.     ($target = $opt_f) =~ s#/$##g;
  56.   }
  57. else
  58.   {
  59.     print("You must specify a scorefile with the '-f scorefile' option.\n");
  60.     print("Try 'cleanscore -h' for a more detailed help\n");
  61.     exit 1;
  62.   }
  63.   
  64. if ($DEBUG)
  65.   {
  66.     print ("Version: $version\n");
  67.     if (defined($opt_k)) {print ("Keep: $keep ($opt_k)\n");}
  68.     print ("\n");
  69.   }
  70.  
  71. if (-f $target)
  72.   {
  73.     clean_file($target);
  74.   }
  75. elsif (-d $target)
  76.   {
  77.     my $bak_pat=$bak_ext;
  78.     opendir(SCOREDIR, $target) || die ("Can't open $target: $!");
  79.     # escape characters with special meaning.
  80.     $bak_pat=~ s/\./\\./g;
  81.     foreach (readdir(SCOREDIR))
  82.       {
  83.         if (/^\.\.?$/) {next;} # skip '.' and '..' 
  84.     if (/$bak_pat$/o) {next;} # skip $bak_ext
  85.     if ($ign_pat) { if (/$ign_pat$/o) {next;} };
  86.     unless ( -f "$target/$_") {next;} # skip everything that is not a normal file.
  87.     clean_file("$target/$_");
  88.       }
  89.   }
  90.  
  91. ############################ END OF MAIN ###############################
  92.  
  93. sub clean_file($)
  94. {
  95.   my $score_file = shift;
  96.   my (@ak_date, $ak_year, $ak_month, $ak_day);
  97.   my ($day, $month, $year);
  98.   my $prev_empty_lines=0, $group= -1;
  99.  
  100.   
  101.   if ($DEBUG)
  102.   {
  103.     print ("\nScorefile: $score_file\n");
  104.     print ("Dates: Entry / System");
  105.     if ($keep) {print (" - $opt_k Days");}
  106.     print ("\n\n");
  107.   }
  108.  
  109.   @ak_date = localtime (time - $keep);
  110.   $ak_year = ($ak_date[5] + 1900);
  111.   $ak_month = ($ak_date[4] + 1);
  112.   $ak_day = $ak_date[3];
  113.  
  114.   unless ($test_only)
  115.     {  
  116.       sysopen (SCORE, "$score_file", O_RDWR) || die ("Can't open $score_file: $!");
  117.       flock (SCORE, LOCK_EX | LOCK_NB) || die ("Can't lock $score_file: $!");
  118.       sysopen (OUT, "$score_file.cs", O_RDWR | O_CREAT) || die ("Can't open $score_file.cs: $!");
  119.       $file_is_changed=0;
  120.     }
  121.   else
  122.     {
  123.       open (SCORE, "$score_file") || die ("Can't read $score_file: $!");
  124.     }
  125.  
  126.   reset_vars();
  127.   @$comment = "";
  128.   $co_line = 0;
  129.  
  130.   #Magic starts here
  131.   while (<SCORE>)
  132.     {
  133.       # Removing empty lines is a problem, we don't know to whitch entrie they belong.
  134.       # So we provide the an option to cut multiple empty lines down to $max_empty_lines 
  135.       if ($max_empty_lines >= 0) 
  136.         {
  137.           if (/^\s*$/)
  138.             {
  139.           if ($prev_empty_lines==$max_empty_lines)
  140.             {
  141.               $file_is_changed=1;
  142.           next;
  143.             }
  144.           else
  145.             {
  146.               $prev_empty_lines++;
  147.             }
  148.         }
  149.           else
  150.             {
  151.           if ($prev_empty_lines)
  152.             {
  153.               $prev_empty_lines=0;
  154.             }
  155.         }
  156.         }
  157.     
  158.       if ($remove_comments) # Remove '%' comments
  159.         {
  160.           if (/^\s*%/)
  161.             {
  162.               if ($VERBOSE || $DEBUG) {print ($_);}
  163.               $file_is_changed=1;
  164.           next;
  165.             }
  166.         }
  167.   
  168.       if (/\%EOS/ || /#EOS/)
  169.         {
  170.           $comment[$co_line] = $_;
  171.           $co_line++;
  172.           insert_comment();        
  173.           end_of_score();
  174.           next;
  175.         }
  176.   
  177.       if (/\%BOS/ || /#BOS/)
  178.         {
  179.           insert_comment();
  180.           end_of_score();
  181.           $seen_bos = 1;
  182.         }
  183.   
  184.       if (/^\s*%/ || /^\s*#/ || /^\s*$/)  # put comments in an extra array
  185.         {
  186.           $comment[$co_line] = $_;
  187.           $co_line++;
  188.           next;
  189.         }
  190.  
  191.       if (/Expires:/i)
  192.         {
  193.           if (/\d{1,2}-\d{1,2}-\d{4}/)
  194.             {
  195.               ($day, $month, $year) = /(\d{1,2})-(\d{1,2})-(\d{4})/;
  196.             }
  197.           else
  198.             {
  199.               ($month, $day, $year) = m#(\d{1,2})/(\d{1,2})/(\d{4})#;
  200.             }
  201.           if ($DEBUG)
  202.             {
  203.               print ("Year: $year / $ak_year\n");
  204.               print ("Month: $month / $ak_month\n");
  205.               print ("Day: $day / $ak_day\n");
  206.             }
  207.           if ($year < $ak_year)
  208.             {
  209.               $is_expired = 1;
  210.             }
  211.           elsif ($year == $ak_year)
  212.             {
  213.               if ($month < $ak_month)
  214.             {
  215.                   $is_expired = 1;
  216.                 }
  217.             elsif ($month == $ak_month)
  218.               {
  219.                   if ($day <= $ak_day) {$is_expired = 1;}
  220.                 }
  221.             }
  222.           if ($DEBUG && $is_expired) {print ("Entry is expired\n");}
  223.         }
  224.  
  225.       if (/^\S*\[.*\]\S*$/)  # Found a new groupexpression - entry ends here
  226.         {
  227.           #unless ($seen_bos)
  228.             #{
  229.       end_of_score();
  230.           insert_comment();
  231.         #}
  232.           $group=$sc_line;
  233.         }
  234.   
  235.       if (/Score:/i)
  236.         {
  237.           if ($seen_score) #there was a 'Score:' before entry ends here
  238.             {
  239.               if ($is_expired && $group >= 0) # Save Groupexp if necessary
  240.                 {
  241.               unless ($test_only) {print (OUT $ak_score[$group]);}
  242.                 }
  243.               end_of_score();
  244.               insert_comment();
  245.               $group = -1;
  246.             }
  247.           $seen_score = 1;
  248.         }
  249.       insert_comment();
  250.       $ak_score[$sc_line] = $_;
  251.       $sc_line++;
  252.     } #while (<SCORE>)
  253.  
  254.   end_of_score();
  255.   insert_comment();
  256.   end_of_score();
  257.  
  258.   unless ($test_only)
  259.     {
  260.       if ($file_is_changed)
  261.         {
  262.           # $score_file.cs contains the new scorefile $score_file the old.
  263.           
  264.       # copy $score_file to $score_file$bak_ext
  265.           seek (SCORE, 0, 0) || die ("Can't rewind $score_file: $!");
  266.           open (DEST, ">$score_file$bak_ext") || die ("Can't write $score_file$bak_ext: $!");
  267.           while (<SCORE>) {print (DEST $_);}
  268.           close (DEST);
  269.           
  270.       # copy $score_file.cs to $score_file
  271.           seek (SCORE, 0, 0) || die ("Can't rewind $score_file: $!");
  272.           truncate (SCORE, 0);
  273.           seek (OUT, 0, 0) || die ("Can't rewind $score_file.cs: $!");
  274.           while (<OUT>) {print (SCORE $_);}
  275.         }
  276.       close (OUT);
  277.       if (-e "$score_file.cs") { unlink("$score_file.cs")};
  278.     }
  279.   close (SCORE);
  280. } #sub clean_file($)
  281.  
  282. sub end_of_score()
  283. {
  284.   unless ($is_expired || $test_only)
  285.     {
  286.       print (OUT @ak_score);
  287.     }
  288.   else
  289.     {
  290.       $file_is_changed=1;
  291.       if ($save_file && $is_expired)
  292.         {
  293.       open (SAVE, ">>$save_file") || die ("Can't append to $save_file: $!");
  294.       print (SAVE @ak_score);
  295.       close (SAVE);
  296.     }
  297.       if ($VERBOSE || $DEBUG)
  298.         {
  299.           print (@ak_score);
  300.           print ("\nNext Entry:\n\n");
  301.         }
  302.     }
  303.   reset_vars();
  304. } #sub end_of_score()
  305.  
  306. sub insert_comment()
  307. {
  308.   if ($co_line)
  309.     {
  310.       for ($i=0; $i < $co_line; $i++)
  311.         {
  312.           $ak_score[$sc_line] = $comment[$i];
  313.           $sc_line++;
  314.         }
  315.     }
  316.   $co_line = 0;
  317.   @comment = "";
  318. }
  319.  
  320. sub reset_vars()
  321. {
  322.   @ak_score ="";
  323.   $is_expired = 0;
  324.   $seen_bos = 0;
  325.   $seen_score = 0;
  326.   $sc_line = 0;
  327. }
  328.  
  329. sub help()
  330. {
  331.   print <<EOF;
  332. cleanscore - Remove expired entries from slrn's Scorefile.
  333.  
  334.    -V              "Version."  Print Version and exit.
  335.    -h              "Help".     Prints a help message.
  336.  
  337.  
  338.    -b <extension>  "Backup extention".   Overwrites the default backup-
  339.                    extention ('.bak')
  340.            
  341.    -d              "Debug."    Prints dates and status for each entry.
  342.  
  343.    -e n            "Empty lines." Cut multiple empty lines down to N.
  344.    
  345.    -f <filename>   "File".   Chose "filename" for cleaning.   **Required**
  346.                              If "filename" is a directory
  347.                  clean all files in it.
  348.  
  349.    -i <pattern>    "Ignore pattern".   When scanning through a directory
  350.                    ignore files with names matching "pattern".
  351.            The "backup extention" is matcht automaticly.
  352.            
  353.    -k n            "Keep for N days".
  354.                    Do not remove expired entries, but instead hold them
  355.                    for N more days.  This allows to keep expired entries
  356.                    so you can still edit them, eg. change the expiry date.
  357.  
  358.    -r              "Remove".  Removes comment lines, i.e. lines beginning
  359.                    with '%'. (e.g. remove slrn generated comments
  360.                    when you use '#' for your own comments).
  361.  
  362.    -s <filename>   "Save to". Save removed entries to "filename".
  363.  
  364.    -t              "Test".  Just check for expired entries
  365.                    but do not change the scorefile.
  366.                    Make sense with options -v or -d only.
  367.  
  368.    -v              "Verbose".  Prints all expired entries to stdout.
  369. EOF
  370. }
  371.